Custom Field
Custom fields are additional fields that can be added to a property or reservation to store additional information. These fields can be used to store information that is not available in the standard fields.
Fields​
| Field Name | Type | Description |
|---|---|---|
| id | string/number | Unique identifier for the custom field. |
| name | string | Name of the custom field. |
| entityType | CustomFieldEntityType | Type of entity the custom field is associated with. |
| value | any | Value of the custom field. |
| type | CustomFieldType | Type of the custom field. |
| defaultValue | any | Default value of the custom field. |
| defaultValueType | string | Type of the default value. |
| placeholder | string | Placeholder text for the custom field. |
Enums​
CustomFieldEntityType​
PROPERTY = 'property',
RESERVATION = 'reservation',
TASK = 'task',
AVAILABILITY = 'availability',
CALENDAR = 'calendar',
CONVERSATION = 'conversation',
CUSTOM_FIELD = 'customField',
GUEST = 'guest',
QUOTE = 'quote',
OWNER = 'owner',
CustomFieldType​
TEXT = 'text',
LONG_TEXT = 'long_text',
NUMBER = 'number',
DATE = 'date',
TIME = 'time',
BOOLEAN = 'boolean',
DROPDOWN = 'dropdown',
Supported Methods​
| Methods | Hostaway | Hostify | Guesty | Hostfully | Fantasticstay | Uplisting | OwnerRez |
|---|---|---|---|---|---|---|---|
| Get All Custom Fields | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Get a Custom Field | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ |
| Create Custom Field | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ |
| Update Custom Field | ✅ | ✅ | ✅ | - | ✅ | - | ✅ |
| Delete Custom Field | ✅ | ✅ | ✅ | ✅ | ✅ | - | ✅ |
| Set Custom Field Value | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |